Package de.bitmarckservice.kernpruefung

Class DefaultRueckgabe

  • All Implemented Interfaces:
    Rueckgabe
    public class DefaultRueckgabe
extends java.lang.Object
implements Rueckgabe
    (BITMARCK-)Default-Implementierung des Interfaces kernpruefung.Rueckgabe.

    Wenn verfahrensspezifische Rückgabe-Objekte nicht benötigt werden, so darf nur diese Klasse verwendet werden.

    Die Return-Codes (Variablen mit Präfix RETURN_CODE) sind so definiert, dass sie geodert werden können. Wenn z.B. Hinweise und Fehler erkannt werden, so werden RETURN_CODE_FEHLER und RETURN_CODE_HINWEIS durch bitweises Oder verknüpft. Pflegehinweis: Diese Return-Codes wurden im Rahmen einer AG-Sitzung so vereinbart, so dass die Werte der Konstanten hier nicht verändert werden dürfen.

    See Also:
    Rueckgabe

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int RETURN_CODE_ABBRUCH
      ReturnCode: Prüfung konnte nicht durchgeführt werden und wurde abgebrochen.
      static int RETURN_CODE_FEHLER
      ReturnCode: Prüfung ergab Fehler.
      static int RETURN_CODE_HINWEIS
      ReturnCode: Prüfung ergab Hinweise auf mögliche Fehler.
      static int RETURN_CODE_OK
      ReturnCode: Alle Daten sind plausibel gemäß des Fehlerkatalogs, keine Fehler, keine Hinweise auf Fehler.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addRueckgabeMeldung​(java.lang.String meldung)
      Aufruf von addRueckgabeMeldung(meldung, RETURN_CODE_FEHLER).
      void addRueckgabeMeldung​(java.lang.String meldung, int returnCode)
      Fügt eine neue Rückgabe-Meldung an und aktualisiert den Return-Code.
      int getReturnCode()
      Liefert den ReturnCode einer Prüfung.
      java.lang.String[] getRueckgabeMeldungen()
      Liefert Fehler-Meldungen zu einer Prüfung oder null, falls keine Fehler oder Hinweise erkannt wurden.
      void setAbbruch()
      Aktualisiert den Return-Code dieses Objektes um RETURN_CODE_ABBRUCH.
      java.lang.String toString()
      Liefert den Return-Code, Fehler-Anzahl und alle Meldungen in einem einzigen String.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • RETURN_CODE_ABBRUCH

        public static final int RETURN_CODE_ABBRUCH
        ReturnCode: Prüfung konnte nicht durchgeführt werden und wurde abgebrochen. Beispiel: Datensatz ist ein Null-Pointer.
        See Also:
        Constant Field Values

      • RETURN_CODE_FEHLER

        public static final int RETURN_CODE_FEHLER
        ReturnCode: Prüfung ergab Fehler.
        See Also:
        Constant Field Values

      • RETURN_CODE_HINWEIS

        public static final int RETURN_CODE_HINWEIS
        ReturnCode: Prüfung ergab Hinweise auf mögliche Fehler.
        See Also:
        Constant Field Values

      • RETURN_CODE_OK

        public static final int RETURN_CODE_OK
        ReturnCode: Alle Daten sind plausibel gemäß des Fehlerkatalogs, keine Fehler, keine Hinweise auf Fehler.
        See Also:
        Constant Field Values

    • Constructor Detail

      • DefaultRueckgabe

        public DefaultRueckgabe()

    • Method Detail

      • addRueckgabeMeldung

        public void addRueckgabeMeldung​(java.lang.String meldung,
                                int returnCode)
        Fügt eine neue Rückgabe-Meldung an und aktualisiert den Return-Code.

        An die bereits existierenden Meldungen wird die hier übergebene Meldung angehängt. Sind bereits MAX_ANZAHL_FEHLER Meldungen vorhanden, so hat der Aufruf dieser Methode keine Wirkung. Ausnahme: Wenn nur Hinweise vorhanden sind, so ersetzt eine Fehlermeldung oder Abbruchmeldung den letzten Hinweis und der Return-Code wird aktualisiert.

        Der vorhandene Return-Code dieses Objektes wird mit dem Argument returnCode geodert (bitweises Oder).

        Ist meldung gleich null oder returnCode außerhalb des Wertebereiches (siehe Parameterbeschreibung), so hat der Aufruf dieser Methode keine Wirkung.

        Die Meldung wird ggf. mit Leerzeichen rechtsbündig aufgefüllt oder rechts gekürzt, so dass sie exakt 76 Zeichen lang wird.

        Hat returnCode den Wert RETURN_CODE_ABBRUCH, so werden vorherige Meldungen gelöscht.

        Parameters:
        meldung - Meldung, die eingefügt werden soll.
        returnCode - Return-Code: RETURN_CODE_ABBRUCH, RETURN_CODE_FEHLER, RETURN_CODE_HINWEIS.
        See Also:
        RETURN_CODE_ABBRUCH, RETURN_CODE_FEHLER, RETURN_CODE_HINWEIS

      • getRueckgabeMeldungen

        public java.lang.String[] getRueckgabeMeldungen()
        Liefert Fehler-Meldungen zu einer Prüfung oder null, falls keine Fehler oder Hinweise erkannt wurden.
        Specified by:
        getRueckgabeMeldungen in interface Rueckgabe
        Returns:
        String[] Fehler-Meldungen zu einer Prüfung oder null, falls keine Fehler oder Hinweise erkannt wurden
        See Also:
        Rueckgabe.getRueckgabeMeldungen()

      • setAbbruch

        public void setAbbruch()
        Aktualisiert den Return-Code dieses Objektes um RETURN_CODE_ABBRUCH.

        Diese Methode wird benutzt, falls ein Abbruch gesetzt werden soll, jedoch keine zugehörige Meldung vorliegt.

      • toString

        public java.lang.String toString()
        Liefert den Return-Code, Fehler-Anzahl und alle Meldungen in einem einzigen String.

        Das Format des hier generierten Strings lautet: Return-Code + Anzahl Fehler + Meldungen.

        An der ersten Position befindet sich der Return-Code, an der zweiten Stelle die Anzahl der Fehler. Falls Meldungen vorhanden sind, werden diese in der Index-Reihenfolge von getRueckgabeMeldungen() angehängt. Jede Melung wird auf genau 76 Zeichen erweitert oder getrimmt, so dass der Rückgabe-String ab der 3. Position als interne Struktur aus Substring-Blöcken von jeweils 76 Zeichen besteht.

        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()